home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 011a / fkey13.zip / FKEY13.DOC < prev   
Text File  |  1991-10-26  |  10KB  |  219 lines
  1.  
  2.  ╔════════════════════════════════════════════════════════════════════════╗ 
  3.  ║                                                                        ║
  4.  ║                         FKEY.COM VERSION 1.3                           ║
  5.  ║                      Copyright (c) OCTOBER,1991                        ║
  6.  ║                           DARRELL HENSLEY                              ║
  7.  ║                                                                        ║
  8.  ╚════════════════════════════════════════════════════════════════════════╝
  9.  
  10.   
  11.   Provided by:
  12.  
  13.  ╔═══════════════════════════════════════════════════════╗
  14.  ║                                                       ║    SOFTWARE
  15.  ║     ┌───                 ┐                           ║    O           S
  16.  ║     ├─ ┌──┐ ┬  ┬ ┌──┐ ┌──┤ ┌──┐ ──┼── ┬ ┌──┐ ┌──┐     ║    U ███████  ▄O
  17.  ║     │  │  │ │  │ │  │ │  │ ├──┤   │   │ │  │ │  │     ║    R     o     U
  18.  ║     ┴  └──┘ └──┘ ┴  ┴ └──┘ ┴  ┴   ┴   ┴ └──┘ ┴  ┴     ║    C     █     R
  19.  ║                                                       ║    E     ▀     C
  20.  ║   Remote Bulletin Board System (RBBS) (215) 693-6780  ║         SOFTWARE
  21.  ╚═══════════════════════════════════════════════════════╝
  22.  
  23.  
  24.              
  25.  ██████████████████████████████████████████████████████████████████████████                     
  26.  
  27.    WRRANTIES AND LIMITATIONS
  28.                 
  29.    YOU ARE GRANTED PERMISSION TO FREELY DISTRIBUTE FKEY13 IN ITS ORIGINAL
  30.    FORM, WITHOUT ALTERATION, AS LONG AS THIS DOCUMENTATION IS DISTRIBUTED
  31.    ALONG WITH IT AND NO FEE IS CHARGED EXCEPT FOR A REASONABLE FEE FOR
  32.    MEDIA AND SHIPPING COSTS.
  33.  
  34.    I REQUEST THAT YOU DISTRIBUTE IN THE ORIGINAL ZIPPED FORMAT.
  35.  
  36.    I DO NOT WARRANT THAT FKEY13 IS FIT FOR ANY PARTICULAR USE OR IS
  37.    MERCHANTABLE.  THIS PROGRAM IS NOT WARRANTED TO BE FREE OF BUGS, NOR
  38.    IS IT PROVIDED WITH ANY WARRANTY OF ANY KIND, EITHER EXPRESSED OR
  39.    IMPLIED.  IT IS YOUR RESPONSIBILITY TO DETERMINE WHETHER FKEY13
  40.    IS SUITABLE FOR YOU.
  41.  
  42.    IN NO EVENT SHALL I BE HELD RESPONSIBLE FOR INCIDENTAL, SPECIAL OR
  43.    CONSEQUENTIAL DAMAGES, OR LOST DATA OR PROFITS TO ANY PERSON OR ENTITY
  44.    THAT MAY ARISE OUT OF THE USE OF THIS PROGRAM.
  45.  
  46.    THIS PROGRAM IN NO WAY IS INTENDED TO INFRINGE ON ANOTHERS COPYRIGHTED
  47.    MATERIAL.  IF A CLAIM CAN BE JUSTIFIED THAT ANY PORTION OF THE CODE OR
  48.    FILENAME EXISTED BEFORE, I AM WILLING TO CHANGE IT.
  49.  
  50.  ██████████████████████████████████████████████████████████████████████████
  51.  
  52.  
  53.  
  54.  INTRODUCTION      
  55.     
  56.     FKEY is a utility for DOS based systems.  With FKEY, you will be
  57.   able to assign various character strings MACROS to your function keys.
  58.   These assignments will greatly enhance the use of your PC to it's fullest
  59.   potential.  The assignments can be made from within your autoexec.bat file 
  60.   or from the DOS command prompt.
  61.  
  62.  
  63.  
  64.  A LITTLE THEORY
  65.  
  66.   DOS assigns some default items to the function keys.  These are as follows.
  67.  
  68.   F1     Copies one character from the template to the command line.
  69.   F2     Copies characters up to the character specified in the template
  70.        and puts these characters on the command line.
  71.   F3     Copies all remaining characters in the template to the command line.
  72.   F4     Skips over (does not copy) the characters in the template up to the
  73.        character specified.
  74.   F5     Makes the new line the new template.
  75.   F6     Types a Ctrl-Z (end-of-file character)
  76.   F7     Input a NULL (ASCII 00) into a DOS command. (Dont ask me ?)
  77.  
  78.   For an in depth discussion of these keys and their uses refer to your DOS
  79.   manual.  You are free to re-assign any of these keys if you do not find 
  80.   them to be of any use to you.
  81.  
  82.   F8 thru F12 are not assigned any values by any versions of DOS that I am
  83.   aware of.  Although space is saved in your environment so that these
  84.   assignments can be made.  The amount of space put aside by DOS varies from
  85.   version to version.  At a minimum you should have room for 128 characters
  86.   to a maximum of 512 characters.
  87.  
  88.  
  89.  
  90.  GETTING STARTED
  91.  
  92.     FKEY requires ANSI.SYS to be installed as a device driver. It will 
  93.   not function properly if ANSI.SYS is not available.  
  94.     
  95.     Now that you know a little about the function keys, it is time to
  96.   decide what MACROS you need and how to install them automatically every
  97.   time you start your computer.
  98.  
  99.     For example, suppose you want to install a MACRO that changes to your
  100.   telecommunications directory and then starts your program instantly with 
  101.   just one key stroke. The syntax would be something like this: 
  102.   
  103.   FKEY [NUMBER] [OPTION] [MACRO] 
  104.   
  105.     You will have to insert a number from 1 to 10, (Or to 12 if you have 
  106.   an extended keyboard) in place of the NUMBER switch.  Insert an @ symbol
  107.   in the position of the OPTION switch to turn off normal FKEY screen output.
  108.   Of course this is optional and can be omitted to recieve a status message,
  109.   displaying your accomplishments.  In place of the MACRO switch you will have 
  110.   to enter the command that you want performed.  This command must be enclosed 
  111.   in quotes.  One special character, the ^ character signifies to FKEY that you
  112.   would like a  carriage return inserted in the MACRO definition at that 
  113.   particular spot.  More on special characters later.
  114.  
  115.     To continue with the communications example above, you would need to
  116.   create something similar to this:
  117.  
  118.   FKEY 12 "C:^CD COMM^COMMPGM^"                NOTE: Case is not significant.
  119.  
  120.     This assigns a MACRO to function key 12.  The assignment can be
  121.   made from DOS, or from any batch file.  From this point on, pressing key
  122.   F12 will cause your computer to:
  123.   
  124.   1) C:[C/R]             Switch to drive C: 
  125.   2) CD COMM[C/R]        Then change to the COMM directory 
  126.   3) COMMPGM[C/R]        Then start your COMMPGM (communications program).  
  127.   
  128.   All this from one key strike !!  
  129.  
  130.  
  131.  SPECIAL KEYS
  132.     
  133.     FKEY prints a status message to the screen whenever an assignment is
  134.   made.  If you do not want the output of FKEY to be printed to the screen,
  135.   you may insert a @ symbol between the function key NUMBER and the MACRO.
  136.   This will only turn off the normal output of FKEY.  Error messages will
  137.   still be shown.  This can be extremely helpful at bootup or during other
  138.   batch files where you dont want items cluttering the screen.
  139.  
  140.     One other special character is the ^ symbol.  As described earlier
  141.   the ^ symbol inserts a carriage return in the MACRO at that specific 
  142.   location.  More than one ^ symbol may appear in any MACRO assignment.
  143.     
  144.  
  145.  LIMITATIONS
  146.  
  147.     Again, FKEY requires ANSI.SYS to be installed as a device driver. 
  148.  
  149.     These MACROS are stored in your computers memory in an area that was 
  150.   set aside by your DOS when it first loaded command com.  By assigning values 
  151.   to the function keys you are using memory that has already been reserved for 
  152.   you.  You are not taking away from your total memory available.  Each 
  153.   version of DOS reserves different amounts of space for it's function keys.  
  154.   FKEY will not allow you to assign more MACROS than you have space for.  You 
  155.   will have to experiment to find your maximum limits.  Earlier versions of 
  156.   DOS supported up to 128 bytes and later versions up to 512 bytes.  
  157.  
  158.     No single MACRO definition can exceed 112 characters.  
  159.  
  160.     Since the special character ^, was choosen to symbolize a [C/R] you
  161.   will not be able to use it in the literal sense.  In other words you will
  162.   not be able use an FKEY MACRO to operate on a file that has a ^ character 
  163.   in it's filename.
  164.  
  165.     Also since the " symbol is being used to mark the MACRO, you cannot
  166.   use them in the middle of your MACRO.  All MACRO's must start with a "
  167.   and end with a ".   Using quotes in this manner gives FKEY the ability to
  168.   support re-direction > and more |.
  169.  
  170.  
  171.  A TAD BIT TECHNICAL
  172.  
  173.     FKEY was specificlly written to be called from batch files.  FKEY
  174.   fully supports sophisticated batch files that interact with its users.
  175.   If you are prompting a user to enter the MACRO or the function key from
  176.   within a batch file then you will need to add a test after the call to 
  177.   FKEY to see that everything went as planned.  When an assignment was made
  178.   as planned FKEY will return a 0 to your batch file.  If the assignment did
  179.   not go as planned it will print an error message and return a 1 to your
  180.   batch file.  Be forwarned, because it may be benificial to some users to
  181.   assign a non DOS command, (There Name for example).  FKEY will return a 0
  182.   to any MACRO assignment that went as requested.
  183.  
  184.     Normal users will not have to be worried about this return value, it
  185.   will be transparent to you, and it will be disregarded by DOS since it is 
  186.   not needed.
  187.  
  188.     FKEY actually replaces the key code of the function key you specify, 
  189.   with the MACRO you specify.  This is a valid option given to you by DOS,  
  190.   and in most instances it will cause no problems.  It is conceivable though 
  191.   that other programs might test the function keys for various reasons.  I
  192.   only know of one program (not to be mentioned) that checks to be sure your 
  193.   function keys are at the DOS defaults, and it will fail if they are not !!
  194.   Since changing key codes is supported by DOS, and heavily documented in the
  195.   manual, I feel a programmer should not force the defaults on you.  In any
  196.   event if you find another program that does not support this DOS given rite,
  197.   you may type FKEY R to reset your function keys to the DOS defaults.
  198.  
  199.  
  200.  
  201.  IN CLOSING      
  202.  
  203.     FKEY was written using the C language.  You may obtain the latest 
  204.  release by calling the Foundation RBBS at (215)693-6780.  Comments, 
  205.  suggestions, ideas for improvements, or CONTRIBUTIONS would be greatly 
  206.  appreciated !!  Watch for other utilities from the Foundation in the near 
  207.  future.
  208.  
  209.     If you experience any difficulty or find any bugs in the program,
  210.  please contact me so that I can correct the matter.  Thanks!
  211.  
  212.  
  213.  Author:
  214.  Darrell Hensley
  215.  RD #1 Box 320
  216.  Robesonia, Pa. 19551
  217.  
  218.  Last Doc Revision 10/26/91 09:00am
  219.